RUBY-3902 "MongoDB Server Version" should be "MongoDB Atlas Server Version"#3077
Open
jamis wants to merge 1 commit into
Open
RUBY-3902 "MongoDB Server Version" should be "MongoDB Atlas Server Version"#3077jamis wants to merge 1 commit into
jamis wants to merge 1 commit into
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
Updates the MongoDB Ruby driver’s Mongo::Client option documentation to clarify that certain overload-related options depend specifically on the MongoDB Atlas server version, per RUBY-3902.
Changes:
- Adjusted the
:enable_overload_retargetingoption docstring to reference “MongoDB Atlas Server Version 9.0 and above”. - Adjusted the
:max_adaptive_retriesoption docstring to reference “MongoDB Atlas Server Version 9.0 and above”.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| # the driver deprioritizes a server that returns an overload error, | ||
| # reducing the likelihood of retrying on the same overloaded server. | ||
| # This option works with MongoDB Server Version 9.0 and above. | ||
| # This option works with MongoDB Atlas Server Version 9.0 and above. |
| # @option options [ Integer ] :max_adaptive_retries The maximum number of | ||
| # retries to attempt when the driver encounters overload errors. This | ||
| # option works with MongoDB Server Version 9.0 and above. Default: 2. | ||
| # option works with MongoDB Atlas Server Version 9.0 and above. Default: 2. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
RUBY-3902 requires that the server version disclaimer specifically call out the Atlas server version.